home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / stock103.zip / COMMANDS.BOI < prev    next >
Text File  |  1992-08-30  |  12KB  |  273 lines
  1. This document is effective 8/30/92
  2. COMMANDS - BOI 1.38
  3.  
  4.     BBS Onliner Interface
  5.     Copyright (C) 1990,1992 Andrew J. Mead
  6.     All Rights Reserved.
  7.  
  8. Introduction
  9.  
  10.     This documentation is a User's Reference Manual for the BBS Onliner
  11.     Interface.  It details available command line parameters and SysOp
  12.     control function keys.  Important Note: All features discussed may
  13.     not be available any given door, and any given door may have
  14.     additional features that are not covered here.  Please refer to any
  15.     door specific documentation as well.
  16.  
  17.       Sections
  18.  
  19.       Command Line Parameters Reference
  20.         BBS Drop File Commands
  21.         Communications Directives
  22.           Local Play
  23.           FOSSIL Communications
  24.           Internal Asynchronious Communications
  25.           Additional Communication Directives
  26.         Configuration Directives
  27.  
  28.       SysOp Function Keys
  29.  
  30.  
  31. BBS Onliner Interface - Command Line Parameters Reference
  32.  
  33.     Notice - This is a listing of all parameters available in the BBS
  34.         Onliner Interface. Not all of these commands may be available
  35.         or have any meaning for the door you are installing.  Also
  36.         note that on the commands that take additional parameters, that
  37.         the initial colon (:) is usually optional, and is only used for
  38.         clarity.
  39.  
  40.     BBS Drop File Commands
  41.         The BOI automatically reads many common drop files, as well as
  42.         being able to accept command line parameters directly from the
  43.         BBS.  Please check the list below for a dropfile created by
  44.         your BBS software.  See INSTALL.BOI for specific information
  45.         and examples.
  46.  
  47.         This list is far from comprehensive, and I encourage any and all
  48.         of you to send me samples of your installation, or information
  49.         about what drop file(s) your BBS can create.
  50.  
  51.         command   dropfile      BBS software - Notes
  52.          /1       PCBOARD.SYS   PCBoard 12.x (see /P)
  53.          /2       JUMBER.DAT    2 A.M.
  54.          /3                     OPUS 1.13 (not available)
  55.          /4       CHAIN.TXT     WWIV, VBBS, TAG, Telegard
  56.          /5       CURRUSER.BBS  RyBBS
  57.          /6       SFDOORS.DAT   Spitfire BBS
  58.          /7       AUNTIE.SYS    Auntie BBS (same format as /1)
  59.          /8                     Sapphire BBS (not available)
  60.          /9       command line  Searchlight, Remote Access, Simplex
  61.          /D       DOOR.SYS      DoorWay to Unlimited Doors, GT
  62.                                 NOTE:This is the "Short" Door.Sys see /S
  63.          /F       USERINFO.TXT  Forum
  64.          /G                     Genesis (not available)
  65.          /H       INFO.TXT      Phoenix
  66.          /M       NUMBER.TXT    ModuleX
  67.          /O       LASTUSER.DAT  Opus 1.14
  68.          /Oxx     LASTUSxx.DAT  Opus 1.14 where "xx" is the task number
  69.                                 in hexadecimal
  70.          /P       PCBOARD.SYS   PCBoard 14.x (see /1)
  71.          /S       DOOR.SYS      GAP, Force
  72.                                 NOTE: This is the "Long" Door.Sys see /D
  73.          /W       CALLINFO.BBS  WildCat!, Telegard
  74.  
  75.          /R       DOORINFO.DEF  DorInfo is the most widely used file.
  76.          /R#      DORINFO#.DEF  EIS-PC, FoReM, OLEcom, QuickBBS, RBBS,
  77.                                 Remote Access, TAG, TPBoard, UBBS, and
  78.                                 VBBS. the "#" represents the node number
  79.  
  80.         If this command is missing, the door will default to local mode.
  81.  
  82.         Drop File Path
  83.             If (as recommended) you do not run your online doors from
  84.             your BBS directory, you need to tell the BOI where to find
  85.             the drop file.  You can either copy the file, or add the
  86.             drop file's path to the command line.  Here's an example
  87.             with WildCat! assuming the BBS is in c:\wcat.
  88.  
  89.           doorgame /w:c:\wcat\
  90.  
  91.             Note: the "\" on the end of the path is required, and that
  92.             the first ":" (w:c) is optional (for clarity).
  93.  
  94.         The BOI reads user name, user time remaining, user comm port,
  95.         and (where available) user handle, user screen size, and if the
  96.         user is on the local console.
  97.  
  98.  
  99.     Communications Directives
  100.         Left to its own, the interface will normally detect local play
  101.         from the drop file.  The override switches (/C, /I, /L) should
  102.         only be used with great care.
  103.  
  104.         LOCAL play
  105.             The BOI will normally sense local play, but you can force it
  106.  
  107.             command   effect
  108.              /L       Force LOCAL mode.  Can NOT be overridden.  If
  109.                       either /c or /i is present the door will exit.
  110.  
  111.         FOSSIL Communications
  112.             FOSSIL communications are automatically sensed and used if
  113.             present.  You can, however, influence, their use.  You
  114.             should also note that there are NO slashes (/) before these
  115.             FOSSIL commands.
  116.  
  117.             command   effect
  118.              F-       Do NOT use FOSSIL (/i command gives same result)
  119.  
  120.              F+       Force FOSSIL use. (ignored if /i command present)
  121.                       If FOSSIL not found, door will exit.
  122.  
  123.              F@       Deinitialize FOSSIL when through.  By default, the
  124.                       BOI keeps the FOSSIL "hot".  This can be combined
  125.                       with the above option (F+@).
  126.  
  127.              /C:n     comport to use (see /C:n below).
  128.  
  129.         Internal Asynchronious Communincations
  130.             The BOI contains its own fully functional communciations
  131.             library that is very configurable.  If FOSSIL is either
  132.             disabled or not found, these routines will be used.
  133.  
  134.             command   effect
  135.              /B       Locked BAUD (DTE-DCE) rate.  If you are running
  136.                       your modem with a "locked" baud rate, you will
  137.                       NEED to add this command to your command line.
  138.                       The internal routines use RTS handshaking by
  139.                       default.  This switch tells them to use CTS/RTS
  140.                       handshaking which prevents modem overrun.
  141.  
  142.              /C:n     Serial port to use.  You can force the program to
  143.                       use a given serial port.  Valid values are from
  144.                       1 to 8.  (NOTE: 5 to 8 are only defined if the
  145.                       FOSSIL is also used).  This command is necessary
  146.                       if the drop file is wrong, or you are using
  147.                       command line directives only.  If /l or /i is
  148.                       present the door will exit.
  149.  
  150.             /I:x:nnnn Non-standard IRQ specification.  If you are not
  151.                       using FOSSIL, and you do have a non-standard
  152.                       serial port configuartion, you can use this
  153.                       option to specify your IRQ/port address info.
  154.                       The default settings, would be equivalent to
  155.                           Com1 : /i:4:03f8
  156.                           Com2 : /i:3:02f8
  157.                           Com3 : /i:4:03e8
  158.                           Com4 : /i:3:02e8
  159.                       The 'x' is the IRQ number.  It is a hexidecimal
  160.                       value from 0 to f.  'nnnn' is the port address for
  161.                       communications.  It is a 4 digit hexidecimal value
  162.                       If this command is present, the FOSSIL routines
  163.                       will not be used.  If /c or /l is present the door
  164.                       will exit.
  165.  
  166.         Additional Communications Directives
  167.             command   effect
  168.              /K       Do NOT check for Carrier detect.  This should only
  169.                       be used in dire cases.  If this switch is used,
  170.                       the door may not time out if the remote user hangs
  171.                       up the phone.
  172.  
  173.                       If your modem does not properly maintain a Carrier
  174.                       Detect signal, the game will automatically abort.
  175.                       This option supresses this activity. If you are
  176.                       forced to use this option, you probably are having
  177.                       hardware problems with the modem, RS-232 connector
  178.                       (bad pin or broken wire), or modem cable.
  179.  
  180.  
  181.     Configuration Directives
  182.         command  effect
  183.          /A      Play Again? (default x=10)
  184.          /A:x    If this mode is present, it is available with the door
  185.                  you are using, and the user has more than x minutes
  186.                  remaining, they will be asked if they wish to play
  187.                  again.
  188.  
  189.          /N:...  User Name (ie: /n:Doc_Technical)
  190.                  This option allows you to pass the door the user's name
  191.                  through the command line.  This is handy for BBSes like
  192.                  Searchlight, or if you are playing locally from DOS.
  193.                  Underscores are converted to spaces.
  194.  
  195.          /Q      Quiet Local Mode
  196.                  This will prevent all ^G bells from ringing the local
  197.                  console.  (Unless the door author specifically
  198.                  overrides it).  This option will help SysOps get full
  199.                  nights worth of sleep.
  200.  
  201.          /Z:x    User Time Limit
  202.                  x is an amount of time between 10 and 50.  The user's
  203.                  time allowed will be the lesser of this value, and the
  204.                  amount found in the BBS drop file.
  205.  
  206.          /X:n    Limit Hall of Fame listings
  207.                  You can limit the time any one name appears in the
  208.                  monthly top 20 with this switch.  The default is no
  209.                  limitation.  The recommended limit is 1 or 2.  This
  210.                  keeps a small number of players from monopolizing the
  211.                  game.  If an occassional (non-fanatical) is more likely
  212.                  to see his name listed, he is more likely to play the
  213.                  game.  n is any number from 1 to 19.
  214.  
  215.          /Y      Alternate path/filespec for text Hall of Fame
  216.                  /y:<pathspec>\   (ie: /y:c:\wcat\bulls\)
  217.                      In the sample above, the text Hall of Fame (if
  218.                      applicable) will be placed into c:\wcat\bulls
  219.                      using the default name (found in the games docs).
  220.                  /y:<filespec>    (ie: /y:c:\wcat\bulls\bull4.bbs)
  221.                      In the sample above, the text Hall of Fame will be
  222.                      placed in c:\wcat\bulls, and it will be named
  223.                      bull4.bbs.
  224.  
  225.          A+      Enable AVATAR/1.  WARNING: The AVATAR codes are
  226.                  relatively untested.  If you use this switch, please
  227.                  let me know whether it works or doesn't.
  228.  
  229.  
  230. BBS Onliner Interface - SysOp Function Keys
  231.     The SysOp is afforded the following SysOp functions.
  232.  
  233.     keypress  action
  234.      F2       Toggle User Status Line.  This will toggle between the
  235.               following current modes:
  236.                   Display Time Remaining (default)
  237.                   Display Active Communications (FOSSIL or internal)
  238.                   Display Remote graphics (ASCII, ANSI, AVATAR/1)
  239.  
  240.      F7       Decrement (reduce) user's time remaining by 1 minute.
  241.      F8       Increment (increase) user's time remaining by 1 minute.
  242.  
  243.      F9       Drop Carrier.  (Fake line noise).  This will disconnect
  244.               the current communications and send the user a string of
  245.               random characters to simulate line noise.
  246.  
  247.      F10      Force return to BBS.  This sends the user a notice
  248.               informing them that the SysOp has terminated the session.
  249.               It then returns control to the BBS.  (Ctrl-Break) will
  250.               also exit the game, but not as pleasently.
  251.  
  252.  
  253. BBS Onliner Interface
  254. Copyright (C) 1990, 1992 Andrew J. Mead
  255. All Rights Reserved.
  256.  
  257. Contact:
  258.     Andrew J. Mead
  259.     PO BOX 1155
  260.     Chapel Hill, NC 27514-1155
  261.     USA
  262.  
  263.     1@9952 WWIVnet
  264.     1@9395 VirtualNet
  265.     1:3641/417 FidoNet
  266.     75:7919/417 DoorNet
  267.  
  268.     +919 489 9446 - PCP:NCRTP - V32BIS - 24HRS
  269.  
  270. This interface is currently written in Turbo Pascal 5.5, 6.0 and
  271. can be licensed by other programmers.  Contact me for details.
  272.  
  273. END COMMANDS.BOI